<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>DocumentNavigator xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/jaxen/dom/DocumentNavigator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.jaxen.dom;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * $Header$</em>
<a name="5" href="#5">5</a>   <em class="comment"> * $Revision: 1319 $</em>
<a name="6" href="#6">6</a>   <em class="comment"> * $Date: 2008-04-26 16:44:29 -0700 (Sat, 26 Apr 2008) $</em>
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
<a name="8" href="#8">8</a>   <em class="comment"> * ====================================================================</em>
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
<a name="10" href="#10">10</a>  <em class="comment"> * Copyright 2000-2005 bob mcwhirter &amp; James Strachan.</em>
<a name="11" href="#11">11</a>  <em class="comment"> * All rights reserved.</em>
<a name="12" href="#12">12</a>  <em class="comment"> *</em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Redistribution and use in source and binary forms, with or without</em>
<a name="15" href="#15">15</a>  <em class="comment"> * modification, are permitted provided that the following conditions are</em>
<a name="16" href="#16">16</a>  <em class="comment"> * met:</em>
<a name="17" href="#17">17</a>  <em class="comment"> * </em>
<a name="18" href="#18">18</a>  <em class="comment"> *   * Redistributions of source code must retain the above copyright</em>
<a name="19" href="#19">19</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer.</em>
<a name="20" href="#20">20</a>  <em class="comment"> * </em>
<a name="21" href="#21">21</a>  <em class="comment"> *   * Redistributions in binary form must reproduce the above copyright</em>
<a name="22" href="#22">22</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer in the</em>
<a name="23" href="#23">23</a>  <em class="comment"> *     documentation and/or other materials provided with the distribution.</em>
<a name="24" href="#24">24</a>  <em class="comment"> * </em>
<a name="25" href="#25">25</a>  <em class="comment"> *   * Neither the name of the Jaxen Project nor the names of its</em>
<a name="26" href="#26">26</a>  <em class="comment"> *     contributors may be used to endorse or promote products derived </em>
<a name="27" href="#27">27</a>  <em class="comment"> *     from this software without specific prior written permission.</em>
<a name="28" href="#28">28</a>  <em class="comment"> * </em>
<a name="29" href="#29">29</a>  <em class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="30" href="#30">30</a>  <em class="comment"> * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="31" href="#31">31</a>  <em class="comment"> * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="32" href="#32">32</a>  <em class="comment"> * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="33" href="#33">33</a>  <em class="comment"> * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="34" href="#34">34</a>  <em class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="35" href="#35">35</a>  <em class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="36" href="#36">36</a>  <em class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="37" href="#37">37</a>  <em class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="38" href="#38">38</a>  <em class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="39" href="#39">39</a>  <em class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="40" href="#40">40</a>  <em class="comment"> *</em>
<a name="41" href="#41">41</a>  <em class="comment"> * ====================================================================</em>
<a name="42" href="#42">42</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="43" href="#43">43</a>  <em class="comment"> * individuals on behalf of the Jaxen Project and was originally</em>
<a name="44" href="#44">44</a>  <em class="comment"> * created by bob mcwhirter &lt;bob@werken.com> and</em>
<a name="45" href="#45">45</a>  <em class="comment"> * James Strachan &lt;jstrachan@apache.org>.  For more information on the</em>
<a name="46" href="#46">46</a>  <em class="comment"> * Jaxen Project, please see &lt;<a href="http://www.jaxen.org/" target="alexandria_uri">http://www.jaxen.org/</a>>.</em>
<a name="47" href="#47">47</a>  <em class="comment"> *</em>
<a name="48" href="#48">48</a>  <em class="comment"> * $Id: DocumentNavigator.java 1319 2008-04-26 23:44:29Z elharo $</em>
<a name="49" href="#49">49</a>  <em class="comment">*/</em>
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>  <strong>import</strong> javax.xml.parsers.DocumentBuilder;
<a name="52" href="#52">52</a>  <strong>import</strong> javax.xml.parsers.DocumentBuilderFactory;
<a name="53" href="#53">53</a>  <strong>import</strong> javax.xml.parsers.ParserConfigurationException;
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>  <strong>import</strong> java.io.IOException;
<a name="56" href="#56">56</a>  <strong>import</strong> java.util.HashMap;
<a name="57" href="#57">57</a>  <strong>import</strong> java.util.Iterator;
<a name="58" href="#58">58</a>  <strong>import</strong> java.util.NoSuchElementException;
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>  <strong>import</strong> org.jaxen.DefaultNavigator;
<a name="61" href="#61">61</a>  <strong>import</strong> org.jaxen.FunctionCallException;
<a name="62" href="#62">62</a>  <strong>import</strong> org.jaxen.Navigator;
<a name="63" href="#63">63</a>  <strong>import</strong> org.jaxen.XPath;
<a name="64" href="#64">64</a>  <strong>import</strong> org.jaxen.JaxenConstants;
<a name="65" href="#65">65</a>  <strong>import</strong> org.w3c.dom.Attr;
<a name="66" href="#66">66</a>  <strong>import</strong> org.w3c.dom.Document;
<a name="67" href="#67">67</a>  <strong>import</strong> org.w3c.dom.NamedNodeMap;
<a name="68" href="#68">68</a>  <strong>import</strong> org.w3c.dom.Node;
<a name="69" href="#69">69</a>  <strong>import</strong> org.w3c.dom.NodeList;
<a name="70" href="#70">70</a>  <strong>import</strong> org.w3c.dom.ProcessingInstruction;
<a name="71" href="#71">71</a>  <strong>import</strong> org.xml.sax.SAXException;
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>  <em>/**</em><em> Interface for navigating around the W3C DOM Level 2 object model.</em>
<a name="74" href="#74">74</a>  <em> *</em>
<a name="75" href="#75">75</a>  <em> *  &lt;p></em>
<a name="76" href="#76">76</a>  <em> *  This class is not intended for direct usage, but is</em>
<a name="77" href="#77">77</a>  <em> *  used by the Jaxen engine during evaluation.</em>
<a name="78" href="#78">78</a>  <em> *  &lt;/p></em>
<a name="79" href="#79">79</a>  <em> *</em>
<a name="80" href="#80">80</a>  <em> *  &lt;p>This class implements the {@link org.jaxen.DefaultNavigator} interface</em>
<a name="81" href="#81">81</a>  <em> *  for the Jaxen XPath library.  This adapter allows the Jaxen</em>
<a name="82" href="#82">82</a>  <em> *  library to be used to execute XPath queries against any object tree</em>
<a name="83" href="#83">83</a>  <em> *  that implements the DOM level 2 interfaces.&lt;/p></em>
<a name="84" href="#84">84</a>  <em> *</em>
<a name="85" href="#85">85</a>  <em> *  &lt;p>Note: DOM level 2 does not include a node representing an XPath</em>
<a name="86" href="#86">86</a>  <em> *  namespace node.  This navigator will return namespace nodes</em>
<a name="87" href="#87">87</a>  <em> *  as instances of the custom {@link NamespaceNode} class, and</em>
<a name="88" href="#88">88</a>  <em> *  users will have to check result sets to locate and isolate</em>
<a name="89" href="#89">89</a>  <em> *  these.&lt;/p></em>
<a name="90" href="#90">90</a>  <em> *</em>
<a name="91" href="#91">91</a>  <em> *  @author David Megginson</em>
<a name="92" href="#92">92</a>  <em> *  @author James Strachan</em>
<a name="93" href="#93">93</a>  <em> *</em>
<a name="94" href="#94">94</a>  <em> *  @see XPath</em>
<a name="95" href="#95">95</a>  <em> *  @see NamespaceNode</em>
<a name="96" href="#96">96</a>  <em> */</em>
<a name="97" href="#97">97</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/jaxen/dom/DocumentNavigator.html">DocumentNavigator</a> <strong>extends</strong> <a href="../../../org/jaxen/DefaultNavigator.html">DefaultNavigator</a>
<a name="98" href="#98">98</a>  {
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     
<a name="101" href="#101">101</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="102" href="#102">102</a>     <em class="comment">// Constants.</em>
<a name="103" href="#103">103</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em>/**</em>
<a name="106" href="#106">106</a> <em>     * </em>
<a name="107" href="#107">107</a> <em>     */</em>
<a name="108" href="#108">108</a>     <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 8460943068889528115L; 
<a name="109" href="#109">109</a>     
<a name="110" href="#110">110</a>     <strong>private</strong> <strong>final</strong> <strong>static</strong> <a href="../../../org/jaxen/dom/DocumentNavigator.html">DocumentNavigator</a> SINGLETON = <strong>new</strong> <a href="../../../org/jaxen/dom/DocumentNavigator.html">DocumentNavigator</a>();
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>     
<a name="114" href="#114">114</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="115" href="#115">115</a>     <em class="comment">// Constructor.</em>
<a name="116" href="#116">116</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em>/**</em>
<a name="120" href="#120">120</a> <em>     * Default constructor.</em>
<a name="121" href="#121">121</a> <em>     */</em>
<a name="122" href="#122">122</a>     <strong>public</strong> <a href="../../../org/jaxen/dom/DocumentNavigator.html">DocumentNavigator</a> ()
<a name="123" href="#123">123</a>     {
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <em>/**</em>
<a name="128" href="#128">128</a> <em>     * Get a constant DocumentNavigator for efficiency.</em>
<a name="129" href="#129">129</a> <em>     *</em>
<a name="130" href="#130">130</a> <em>     * @return a constant instance of a DocumentNavigator.</em>
<a name="131" href="#131">131</a> <em>     */</em>
<a name="132" href="#132">132</a>     <strong>public</strong> <strong>static</strong> <a href="../../../org/jaxen/Navigator.html">Navigator</a> getInstance ()
<a name="133" href="#133">133</a>     {
<a name="134" href="#134">134</a>         <strong>return</strong> SINGLETON;
<a name="135" href="#135">135</a>     }
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     
<a name="139" href="#139">139</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="140" href="#140">140</a>     <em class="comment">// Implementation of org.jaxen.DefaultNavigator.</em>
<a name="141" href="#141">141</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>     <em>/**</em>
<a name="145" href="#145">145</a> <em>     * Get an iterator over all of this node's children.</em>
<a name="146" href="#146">146</a> <em>     *</em>
<a name="147" href="#147">147</a> <em>     * @param contextNode the context node for the child axis.</em>
<a name="148" href="#148">148</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="149" href="#149">149</a> <em>     */</em>
<a name="150" href="#150">150</a>     <strong>public</strong> Iterator getChildAxisIterator (Object contextNode)
<a name="151" href="#151">151</a>     {
<a name="152" href="#152">152</a>         <strong>return</strong> <strong>new</strong> NodeIterator ((Node)contextNode) {
<a name="153" href="#153">153</a>                 <strong>protected</strong> Node getFirstNode (Node node)
<a name="154" href="#154">154</a>                 {
<a name="155" href="#155">155</a>                     <strong>return</strong> node.getFirstChild();
<a name="156" href="#156">156</a>                 }
<a name="157" href="#157">157</a>                 <strong>protected</strong> Node getNextNode (Node node)
<a name="158" href="#158">158</a>                 {
<a name="159" href="#159">159</a>                     <strong>return</strong> node.getNextSibling();
<a name="160" href="#160">160</a>                 }
<a name="161" href="#161">161</a>             };
<a name="162" href="#162">162</a>     }
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em>/**</em>
<a name="166" href="#166">166</a> <em>     * Get a (single-member) iterator over this node's parent.</em>
<a name="167" href="#167">167</a> <em>     *</em>
<a name="168" href="#168">168</a> <em>     * @param contextNode the context node for the parent axis</em>
<a name="169" href="#169">169</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="170" href="#170">170</a> <em>     */</em>
<a name="171" href="#171">171</a>     <strong>public</strong> Iterator getParentAxisIterator (Object contextNode)
<a name="172" href="#172">172</a>     {
<a name="173" href="#173">173</a>         Node node = (Node)contextNode;
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>         <strong>if</strong> (node.getNodeType() == Node.ATTRIBUTE_NODE) {
<a name="176" href="#176">176</a>             <strong>return</strong> <strong>new</strong> NodeIterator (node) {
<a name="177" href="#177">177</a>                     <strong>protected</strong> Node getFirstNode (Node n)
<a name="178" href="#178">178</a>                     {
<a name="179" href="#179">179</a>                         <em class="comment">// We can assume castability here because we've already</em>
<a name="180" href="#180">180</a>                         <em class="comment">// tested the node type.</em>
<a name="181" href="#181">181</a>                         <strong>return</strong> ((Attr)n).getOwnerElement();
<a name="182" href="#182">182</a>                     }
<a name="183" href="#183">183</a>                     <strong>protected</strong> Node getNextNode (Node n) {
<a name="184" href="#184">184</a>                         <strong>return</strong> <strong>null</strong>;
<a name="185" href="#185">185</a>                     }
<a name="186" href="#186">186</a>                 };
<a name="187" href="#187">187</a>         } <strong>else</strong> {
<a name="188" href="#188">188</a>             <strong>return</strong> <strong>new</strong> NodeIterator (node) {
<a name="189" href="#189">189</a>                     <strong>protected</strong> Node getFirstNode (Node n)
<a name="190" href="#190">190</a>                     {
<a name="191" href="#191">191</a>                         <strong>return</strong> n.getParentNode();
<a name="192" href="#192">192</a>                     }
<a name="193" href="#193">193</a>                     <strong>protected</strong> Node getNextNode (Node n) {
<a name="194" href="#194">194</a>                         <strong>return</strong> <strong>null</strong>;
<a name="195" href="#195">195</a>                     }
<a name="196" href="#196">196</a>                 };
<a name="197" href="#197">197</a>         }
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a>     
<a name="200" href="#200">200</a>     
<a name="201" href="#201">201</a>     <em>/**</em><em> </em>
<a name="202" href="#202">202</a> <em>     * Return the XPath parent of the supplied DOM node.</em>
<a name="203" href="#203">203</a> <em>     * XPath has slightly different definition of parent than DOM does.</em>
<a name="204" href="#204">204</a> <em>     * In particular, the parent of an attribute is not null.</em>
<a name="205" href="#205">205</a> <em>     * </em>
<a name="206" href="#206">206</a> <em>     * @param child the child node</em>
<a name="207" href="#207">207</a> <em>     * </em>
<a name="208" href="#208">208</a> <em>     * @return the parent of the specified node; or null if</em>
<a name="209" href="#209">209</a> <em>     *     the node does not have a parent</em>
<a name="210" href="#210">210</a> <em>     */</em>
<a name="211" href="#211">211</a>     <strong>public</strong> Object getParentNode(Object child) {
<a name="212" href="#212">212</a>         Node node = (Node) child;
<a name="213" href="#213">213</a>         <strong>if</strong> (node.getNodeType() == Node.ATTRIBUTE_NODE) {
<a name="214" href="#214">214</a>             <strong>return</strong> ((Attr) node).getOwnerElement();
<a name="215" href="#215">215</a>         }
<a name="216" href="#216">216</a>         <strong>return</strong> node.getParentNode();
<a name="217" href="#217">217</a>     }
<a name="218" href="#218">218</a> 
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a>     <em>/**</em>
<a name="221" href="#221">221</a> <em>     * Get an iterator over all following siblings.</em>
<a name="222" href="#222">222</a> <em>     *</em>
<a name="223" href="#223">223</a> <em>     * @param contextNode the context node for the sibling iterator</em>
<a name="224" href="#224">224</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="225" href="#225">225</a> <em>     */</em>
<a name="226" href="#226">226</a>     <strong>public</strong> Iterator getFollowingSiblingAxisIterator (Object contextNode)
<a name="227" href="#227">227</a>     {
<a name="228" href="#228">228</a>         <strong>return</strong> <strong>new</strong> NodeIterator ((Node)contextNode) {
<a name="229" href="#229">229</a>                 <strong>protected</strong> Node getFirstNode (Node node)
<a name="230" href="#230">230</a>                 {
<a name="231" href="#231">231</a>                     <strong>return</strong> getNextNode(node);
<a name="232" href="#232">232</a>                 }
<a name="233" href="#233">233</a>                 <strong>protected</strong> Node getNextNode (Node node) {
<a name="234" href="#234">234</a>                     <strong>return</strong> node.getNextSibling();
<a name="235" href="#235">235</a>                 }
<a name="236" href="#236">236</a>             };
<a name="237" href="#237">237</a>     }
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a> 
<a name="240" href="#240">240</a>     <em>/**</em>
<a name="241" href="#241">241</a> <em>     * Get an iterator over all preceding siblings.</em>
<a name="242" href="#242">242</a> <em>     *</em>
<a name="243" href="#243">243</a> <em>     * @param contextNode the context node for the preceding sibling axis</em>
<a name="244" href="#244">244</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="245" href="#245">245</a> <em>     */</em>
<a name="246" href="#246">246</a>     <strong>public</strong> Iterator getPrecedingSiblingAxisIterator (Object contextNode)
<a name="247" href="#247">247</a>     {
<a name="248" href="#248">248</a>         <strong>return</strong> <strong>new</strong> NodeIterator ((Node)contextNode) {
<a name="249" href="#249">249</a>                 <strong>protected</strong> Node getFirstNode (Node node)
<a name="250" href="#250">250</a>                 {
<a name="251" href="#251">251</a>                     <strong>return</strong> getNextNode(node);
<a name="252" href="#252">252</a>                 }
<a name="253" href="#253">253</a>                 <strong>protected</strong> Node getNextNode (Node node) {
<a name="254" href="#254">254</a>                     <strong>return</strong> node.getPreviousSibling();
<a name="255" href="#255">255</a>                 }
<a name="256" href="#256">256</a>             };
<a name="257" href="#257">257</a>     }
<a name="258" href="#258">258</a> 
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>     <em>/**</em>
<a name="261" href="#261">261</a> <em>     * Get an iterator over all following nodes, depth-first.</em>
<a name="262" href="#262">262</a> <em>     *</em>
<a name="263" href="#263">263</a> <em>     * @param contextNode the context node for the following axis</em>
<a name="264" href="#264">264</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="265" href="#265">265</a> <em>     */</em>
<a name="266" href="#266">266</a>     <strong>public</strong> Iterator getFollowingAxisIterator (Object contextNode)
<a name="267" href="#267">267</a>     {
<a name="268" href="#268">268</a>         <strong>return</strong> <strong>new</strong> NodeIterator ((Node)contextNode) {
<a name="269" href="#269">269</a>                 <strong>protected</strong> Node getFirstNode (Node node)
<a name="270" href="#270">270</a>                 {
<a name="271" href="#271">271</a>                     <strong>if</strong> (node == <strong>null</strong>) {
<a name="272" href="#272">272</a>                         <strong>return</strong> <strong>null</strong>;
<a name="273" href="#273">273</a>                     }
<a name="274" href="#274">274</a>                     <strong>else</strong> {
<a name="275" href="#275">275</a>                         Node sibling = node.getNextSibling();
<a name="276" href="#276">276</a>                         <strong>if</strong> (sibling == <strong>null</strong>) {
<a name="277" href="#277">277</a>                             <strong>return</strong> getFirstNode(node.getParentNode());
<a name="278" href="#278">278</a>                         }
<a name="279" href="#279">279</a>                         <strong>else</strong> {
<a name="280" href="#280">280</a>                             <strong>return</strong> sibling;
<a name="281" href="#281">281</a>                         }
<a name="282" href="#282">282</a>                     }
<a name="283" href="#283">283</a>                 }
<a name="284" href="#284">284</a>                 <strong>protected</strong> Node getNextNode (Node node) {
<a name="285" href="#285">285</a>                     <strong>if</strong> (node == <strong>null</strong>) {
<a name="286" href="#286">286</a>                         <strong>return</strong> <strong>null</strong>;
<a name="287" href="#287">287</a>                     }
<a name="288" href="#288">288</a>                     <strong>else</strong> {
<a name="289" href="#289">289</a>                         Node n = node.getFirstChild();
<a name="290" href="#290">290</a>                         <strong>if</strong> (n == <strong>null</strong>) n = node.getNextSibling();
<a name="291" href="#291">291</a>                         <strong>if</strong> (n == <strong>null</strong>) <strong>return</strong> getFirstNode(node.getParentNode());
<a name="292" href="#292">292</a>                         <strong>else</strong> <strong>return</strong> n;
<a name="293" href="#293">293</a>                     }
<a name="294" href="#294">294</a>                 }
<a name="295" href="#295">295</a>             };
<a name="296" href="#296">296</a>     }
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>     <em>/**</em>
<a name="300" href="#300">300</a> <em>     * Get an iterator over all attributes.</em>
<a name="301" href="#301">301</a> <em>     *</em>
<a name="302" href="#302">302</a> <em>     * @param contextNode the context node for the attribute axis</em>
<a name="303" href="#303">303</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="304" href="#304">304</a> <em>     */</em>
<a name="305" href="#305">305</a>     <strong>public</strong> Iterator getAttributeAxisIterator (Object contextNode)
<a name="306" href="#306">306</a>     {
<a name="307" href="#307">307</a>         <strong>if</strong> (isElement(contextNode)) {
<a name="308" href="#308">308</a>             <strong>return</strong> <strong>new</strong> AttributeIterator((Node)contextNode);
<a name="309" href="#309">309</a>         } 
<a name="310" href="#310">310</a>         <strong>else</strong> {
<a name="311" href="#311">311</a>             <strong>return</strong> JaxenConstants.EMPTY_ITERATOR;
<a name="312" href="#312">312</a>         }
<a name="313" href="#313">313</a>     }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a> 
<a name="316" href="#316">316</a>     <em>/**</em>
<a name="317" href="#317">317</a> <em>     * Get an iterator over all declared namespaces.</em>
<a name="318" href="#318">318</a> <em>     *</em>
<a name="319" href="#319">319</a> <em>     * &lt;p>Note: this iterator is not live: it takes a snapshot</em>
<a name="320" href="#320">320</a> <em>     * and that snapshot remains static during the life of</em>
<a name="321" href="#321">321</a> <em>     * the iterator (i.e. it won't reflect subsequent changes</em>
<a name="322" href="#322">322</a> <em>     * to the DOM).&lt;/p></em>
<a name="323" href="#323">323</a> <em>     * </em>
<a name="324" href="#324">324</a> <em>     * &lt;p></em>
<a name="325" href="#325">325</a> <em>     * In the event that the DOM is inconsistent; for instance a </em>
<a name="326" href="#326">326</a> <em>     * &lt;code>pre:foo&lt;/code> element is declared by DOM to be in the </em>
<a name="327" href="#327">327</a> <em>     * <a href="http://www.a.com/" target="alexandria_uri">http://www.a.com/</a> namespace but also has an </em>
<a name="328" href="#328">328</a> <em>     * &lt;code>xmlns:pre="<a href="http://www.b.com" target="alexandria_uri">http://www.b.com</a>"&lt;/code> attribute; then only </em>
<a name="329" href="#329">329</a> <em>     * one of the namespaces will be counted. This will be the intrinsic</em>
<a name="330" href="#330">330</a> <em>     * namespace of the &lt;code>Element&lt;/code> or &lt;code>Attr&lt;/code> object</em>
<a name="331" href="#331">331</a> <em>     * rather than the one provide by the contradictory namespace </em>
<a name="332" href="#332">332</a> <em>     * declaration attribute. In the event of a contradiction between two</em>
<a name="333" href="#333">333</a> <em>     * attributes on the same element--e.g. &lt;code>pre:foo&lt;/code> in the</em>
<a name="334" href="#334">334</a> <em>     * <a href="http://www.a.com/" target="alexandria_uri">http://www.a.com/</a> namespace and &lt;code>pre:bar&lt;/code> in the </em>
<a name="335" href="#335">335</a> <em>     * <a href="http://www.b.com/" target="alexandria_uri">http://www.b.com/</a> namespace--it is undefined which namespace</em>
<a name="336" href="#336">336</a> <em>     * will be returned. </em>
<a name="337" href="#337">337</a> <em>     * &lt;/p></em>
<a name="338" href="#338">338</a> <em>     *</em>
<a name="339" href="#339">339</a> <em>     * @param contextNode the context node for the namespace axis</em>
<a name="340" href="#340">340</a> <em>     * @return a possibly-empty iterator (not null)</em>
<a name="341" href="#341">341</a> <em>     */</em>
<a name="342" href="#342">342</a>     <strong>public</strong> Iterator getNamespaceAxisIterator (Object contextNode)
<a name="343" href="#343">343</a>     {
<a name="344" href="#344">344</a>         <em class="comment">// Only elements have namespace nodes</em>
<a name="345" href="#345">345</a>         <strong>if</strong> (isElement(contextNode)) {
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>             HashMap nsMap = <strong>new</strong> HashMap();
<a name="348" href="#348">348</a> 
<a name="349" href="#349">349</a>             <em class="comment">// Starting at the current node, walk</em>
<a name="350" href="#350">350</a>             <em class="comment">// up to the root, noting the namespace</em>
<a name="351" href="#351">351</a>             <em class="comment">// declarations in scope.</em>
<a name="352" href="#352">352</a>             <strong>for</strong> (Node n = (Node) contextNode;
<a name="353" href="#353">353</a>                  n != <strong>null</strong>;
<a name="354" href="#354">354</a>                  n = n.getParentNode()) {
<a name="355" href="#355">355</a>                 
<a name="356" href="#356">356</a>                 <em class="comment">// 1. Look for the namespace of the element itself</em>
<a name="357" href="#357">357</a>                 String myNamespace = n.getNamespaceURI();
<a name="358" href="#358">358</a>                 <strong>if</strong> (myNamespace != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(myNamespace)) {
<a name="359" href="#359">359</a>                     String myPrefix = n.getPrefix();
<a name="360" href="#360">360</a>                     <strong>if</strong> (!nsMap.containsKey(myPrefix)) {
<a name="361" href="#361">361</a>                         <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a> ns = <strong>new</strong> <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a>((Node) contextNode, myPrefix, myNamespace);
<a name="362" href="#362">362</a>                         nsMap.put(myPrefix, ns);
<a name="363" href="#363">363</a>                     }
<a name="364" href="#364">364</a>                 }
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a>                 <strong>if</strong> (n.hasAttributes()) {
<a name="367" href="#367">367</a>                     NamedNodeMap atts = n.getAttributes();
<a name="368" href="#368">368</a>                     <strong>int</strong> length = atts.getLength();
<a name="369" href="#369">369</a>                     <em class="comment">// 2. Look for namespaces of attributes</em>
<a name="370" href="#370">370</a>                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; length; i++) {
<a name="371" href="#371">371</a>                         Attr att = (Attr) atts.item(i);
<a name="372" href="#372">372</a>                         <em class="comment">// Work around Crimson bug by testing URI rather than name</em>
<a name="373" href="#373">373</a>                         String attributeNamespace = att.getNamespaceURI();
<a name="374" href="#374">374</a>                         <strong>if</strong> (<span class="string">"http://www.w3.org/2000/xmlns/"</span>.equals(attributeNamespace)) {
<a name="375" href="#375">375</a>                         }
<a name="376" href="#376">376</a>                         <strong>else</strong> <strong>if</strong> (attributeNamespace != <strong>null</strong>) {
<a name="377" href="#377">377</a>                             String prefix = att.getPrefix();
<a name="378" href="#378">378</a>                             <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a> ns =
<a name="379" href="#379">379</a>                                 <strong>new</strong> <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a>((Node)contextNode, prefix, attributeNamespace);
<a name="380" href="#380">380</a>                             <em class="comment">// Add only if there's not a closer declaration in force.</em>
<a name="381" href="#381">381</a>                             <strong>if</strong> (!nsMap.containsKey(prefix)) nsMap.put(prefix, ns);
<a name="382" href="#382">382</a>                             
<a name="383" href="#383">383</a>                         }
<a name="384" href="#384">384</a>                     }
<a name="385" href="#385">385</a>                     
<a name="386" href="#386">386</a>                     <em class="comment">// 3. Look for namespace declaration attributes</em>
<a name="387" href="#387">387</a>                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; length; i++) {
<a name="388" href="#388">388</a>                         Attr att = (Attr) atts.item(i);
<a name="389" href="#389">389</a>                         <em class="comment">// work around crimson bug by testing URI rather than name</em>
<a name="390" href="#390">390</a>                         String attributeNamespace = att.getNamespaceURI();
<a name="391" href="#391">391</a>                         <strong>if</strong> (<span class="string">"http://www.w3.org/2000/xmlns/"</span>.equals(attributeNamespace)) {
<a name="392" href="#392">392</a>                             <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a> ns =
<a name="393" href="#393">393</a>                               <strong>new</strong> <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a>( (Node)contextNode, att);
<a name="394" href="#394">394</a>                             <em class="comment">// Add only if there's not a closer declaration in force.</em>
<a name="395" href="#395">395</a>                             String name = ns.getNodeName();
<a name="396" href="#396">396</a>                             <strong>if</strong> (!nsMap.containsKey(name)) nsMap.put(name, ns);
<a name="397" href="#397">397</a>                         }
<a name="398" href="#398">398</a>                     }
<a name="399" href="#399">399</a>                     
<a name="400" href="#400">400</a>                 }
<a name="401" href="#401">401</a>                 
<a name="402" href="#402">402</a>             }
<a name="403" href="#403">403</a>             <em class="comment">// Section 5.4 of the XPath rec requires</em>
<a name="404" href="#404">404</a>             <em class="comment">// this to be present.</em>
<a name="405" href="#405">405</a>             nsMap.put(<span class="string">"xml"</span>,
<a name="406" href="#406">406</a>                       <strong>new</strong>
<a name="407" href="#407">407</a>                       <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a>((Node)contextNode,
<a name="408" href="#408">408</a>                                     <span class="string">"xml"</span>,
<a name="409" href="#409">409</a>                                     <span class="string">"http://www.w3.org/XML/1998/namespace"</span>));
<a name="410" href="#410">410</a> 
<a name="411" href="#411">411</a>             <em class="comment">// An empty default namespace cancels</em>
<a name="412" href="#412">412</a>             <em class="comment">// any previous default.</em>
<a name="413" href="#413">413</a>             <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a> defaultNS = (NamespaceNode)nsMap.get(<span class="string">""</span>);
<a name="414" href="#414">414</a>             <strong>if</strong> (defaultNS != <strong>null</strong> &amp;&amp; defaultNS.getNodeValue().length() == 0) {
<a name="415" href="#415">415</a>                 nsMap.remove(<span class="string">""</span>);
<a name="416" href="#416">416</a>             }
<a name="417" href="#417">417</a>             <strong>return</strong> nsMap.values().iterator();
<a name="418" href="#418">418</a>         } 
<a name="419" href="#419">419</a>         <strong>else</strong> {
<a name="420" href="#420">420</a>             <strong>return</strong> JaxenConstants.EMPTY_ITERATOR;
<a name="421" href="#421">421</a>         }
<a name="422" href="#422">422</a>     }
<a name="423" href="#423">423</a> 
<a name="424" href="#424">424</a>     <em>/**</em><em> Returns a parsed form of the given XPath string, which will be suitable</em>
<a name="425" href="#425">425</a> <em>     *  for queries on DOM documents.</em>
<a name="426" href="#426">426</a> <em>     *  </em>
<a name="427" href="#427">427</a> <em>     * @param xpath the XPath expression</em>
<a name="428" href="#428">428</a> <em>     * @return a parsed form of the given XPath string</em>
<a name="429" href="#429">429</a> <em>     * @throws org.jaxen.saxpath.SAXPathException if the string is syntactically incorrect</em>
<a name="430" href="#430">430</a> <em>     */</em>
<a name="431" href="#431">431</a>     <strong>public</strong> <a href="../../../org/jaxen/XPath.html">XPath</a> parseXPath (String xpath) throws org.jaxen.saxpath.SAXPathException
<a name="432" href="#432">432</a>     {
<a name="433" href="#433">433</a>         <strong>return</strong> <strong>new</strong> <a href="../../../org/jaxen/dom/DOMXPath.html">DOMXPath</a>(xpath);
<a name="434" href="#434">434</a>     }
<a name="435" href="#435">435</a> 
<a name="436" href="#436">436</a>     <em>/**</em>
<a name="437" href="#437">437</a> <em>     * Get the top-level document node.</em>
<a name="438" href="#438">438</a> <em>     *</em>
<a name="439" href="#439">439</a> <em>     * @param contextNode any node in the document</em>
<a name="440" href="#440">440</a> <em>     * @return the root node</em>
<a name="441" href="#441">441</a> <em>     */</em>
<a name="442" href="#442">442</a>     <strong>public</strong> Object getDocumentNode (Object contextNode)
<a name="443" href="#443">443</a>     {
<a name="444" href="#444">444</a>         <strong>if</strong> (isDocument(contextNode)) <strong>return</strong> contextNode;
<a name="445" href="#445">445</a>         <strong>else</strong> <strong>return</strong> ((Node)contextNode).getOwnerDocument();
<a name="446" href="#446">446</a>     }
<a name="447" href="#447">447</a> 
<a name="448" href="#448">448</a>     <em class="comment">// Why are there separate methods for getElementNamespaceURI and </em>
<a name="449" href="#449">449</a>     <em class="comment">// getAttributeNamespaceURI when they do exactly the same thing?</em>
<a name="450" href="#450">450</a>     <em class="comment">// This should be combined in a future version.</em>
<a name="451" href="#451">451</a>     <em>/**</em>
<a name="452" href="#452">452</a> <em>     * Get the namespace URI of an element.</em>
<a name="453" href="#453">453</a> <em>     *</em>
<a name="454" href="#454">454</a> <em>     * @param element the target node</em>
<a name="455" href="#455">455</a> <em>     * @return a string (possibly empty) if the node is an element,</em>
<a name="456" href="#456">456</a> <em>     * and null otherwise</em>
<a name="457" href="#457">457</a> <em>     */</em>
<a name="458" href="#458">458</a>     <strong>public</strong> String getElementNamespaceUri (Object element)
<a name="459" href="#459">459</a>     {
<a name="460" href="#460">460</a>         <strong>try</strong> {
<a name="461" href="#461">461</a>             Node node = (Node) element;
<a name="462" href="#462">462</a>             <strong>if</strong> (node.getNodeType() == Node.ELEMENT_NODE) {
<a name="463" href="#463">463</a>                 <strong>return</strong> node.getNamespaceURI();
<a name="464" href="#464">464</a>             }
<a name="465" href="#465">465</a>         }
<a name="466" href="#466">466</a>         <strong>catch</strong> (ClassCastException ex) {
<a name="467" href="#467">467</a>         }
<a name="468" href="#468">468</a>         <strong>return</strong> <strong>null</strong>;
<a name="469" href="#469">469</a>     }
<a name="470" href="#470">470</a> 
<a name="471" href="#471">471</a> 
<a name="472" href="#472">472</a>     <em>/**</em>
<a name="473" href="#473">473</a> <em>     * Get the local name of an element.</em>
<a name="474" href="#474">474</a> <em>     *</em>
<a name="475" href="#475">475</a> <em>     * @param element the target node</em>
<a name="476" href="#476">476</a> <em>     * @return a string representing the unqualified local name</em>
<a name="477" href="#477">477</a> <em>     *     if the node is an element, or null otherwise</em>
<a name="478" href="#478">478</a> <em>     */</em>
<a name="479" href="#479">479</a>     <strong>public</strong> String getElementName (Object element)
<a name="480" href="#480">480</a>     {
<a name="481" href="#481">481</a>         <strong>if</strong> (isElement(element)) {
<a name="482" href="#482">482</a>             String name = ((Node)element).getLocalName();
<a name="483" href="#483">483</a>             <strong>if</strong> (name == <strong>null</strong>) name = ((Node)element).getNodeName();
<a name="484" href="#484">484</a>             <strong>return</strong> name;
<a name="485" href="#485">485</a>         }
<a name="486" href="#486">486</a>         <strong>return</strong> <strong>null</strong>;
<a name="487" href="#487">487</a>     }
<a name="488" href="#488">488</a> 
<a name="489" href="#489">489</a> 
<a name="490" href="#490">490</a>     <em>/**</em>
<a name="491" href="#491">491</a> <em>     * Get the qualified name of an element.</em>
<a name="492" href="#492">492</a> <em>     *</em>
<a name="493" href="#493">493</a> <em>     * @param element the target node</em>
<a name="494" href="#494">494</a> <em>     * @return a string representing the qualified (i.e. possibly</em>
<a name="495" href="#495">495</a> <em>     *   prefixed) name if the argument is an element, or null otherwise</em>
<a name="496" href="#496">496</a> <em>     */</em>
<a name="497" href="#497">497</a>     <strong>public</strong> String getElementQName (Object element)
<a name="498" href="#498">498</a>     {
<a name="499" href="#499">499</a>         <strong>try</strong> {
<a name="500" href="#500">500</a>             Node node = (Node) element;
<a name="501" href="#501">501</a>             <strong>if</strong> (node.getNodeType() == Node.ELEMENT_NODE) {
<a name="502" href="#502">502</a>                 <strong>return</strong> node.getNodeName();
<a name="503" href="#503">503</a>             }
<a name="504" href="#504">504</a>         }
<a name="505" href="#505">505</a>         <strong>catch</strong> (ClassCastException ex) {
<a name="506" href="#506">506</a>         }
<a name="507" href="#507">507</a>         <strong>return</strong> <strong>null</strong>;
<a name="508" href="#508">508</a>     }
<a name="509" href="#509">509</a> 
<a name="510" href="#510">510</a> 
<a name="511" href="#511">511</a>     <em>/**</em>
<a name="512" href="#512">512</a> <em>     * Get the namespace URI of an attribute.</em>
<a name="513" href="#513">513</a> <em>     *</em>
<a name="514" href="#514">514</a> <em>     * @param attribute the target node</em>
<a name="515" href="#515">515</a> <em>     * </em>
<a name="516" href="#516">516</a> <em>     * @return the namespace name of the specified node</em>
<a name="517" href="#517">517</a> <em>     * </em>
<a name="518" href="#518">518</a> <em>     */</em>
<a name="519" href="#519">519</a>     <strong>public</strong> String getAttributeNamespaceUri (Object attribute)
<a name="520" href="#520">520</a>     {
<a name="521" href="#521">521</a>         <strong>try</strong> {
<a name="522" href="#522">522</a>             Node node = (Node) attribute;
<a name="523" href="#523">523</a>             <strong>if</strong> (node.getNodeType() == Node.ATTRIBUTE_NODE) {
<a name="524" href="#524">524</a>                 <strong>return</strong> node.getNamespaceURI();
<a name="525" href="#525">525</a>             }
<a name="526" href="#526">526</a>         }
<a name="527" href="#527">527</a>         <strong>catch</strong> (ClassCastException ex) {
<a name="528" href="#528">528</a>         }
<a name="529" href="#529">529</a>         <strong>return</strong> <strong>null</strong>;
<a name="530" href="#530">530</a>     }
<a name="531" href="#531">531</a> 
<a name="532" href="#532">532</a> 
<a name="533" href="#533">533</a>     <em>/**</em>
<a name="534" href="#534">534</a> <em>     * Get the local name of an attribute.</em>
<a name="535" href="#535">535</a> <em>     *</em>
<a name="536" href="#536">536</a> <em>     * @param attribute the target node</em>
<a name="537" href="#537">537</a> <em>     * @return a string representing the unqualified local name</em>
<a name="538" href="#538">538</a> <em>     * if the node is an attribute, or null otherwise</em>
<a name="539" href="#539">539</a> <em>     */</em>
<a name="540" href="#540">540</a>     <strong>public</strong> String getAttributeName (Object attribute)
<a name="541" href="#541">541</a>     {
<a name="542" href="#542">542</a>         <strong>if</strong> (isAttribute(attribute)) {
<a name="543" href="#543">543</a>             String name = ((Node)attribute).getLocalName();
<a name="544" href="#544">544</a>             <strong>if</strong> (name == <strong>null</strong>) name = ((Node)attribute).getNodeName();
<a name="545" href="#545">545</a>             <strong>return</strong> name;
<a name="546" href="#546">546</a>         }
<a name="547" href="#547">547</a>         <strong>return</strong> <strong>null</strong>;
<a name="548" href="#548">548</a>     }
<a name="549" href="#549">549</a> 
<a name="550" href="#550">550</a> 
<a name="551" href="#551">551</a>     <em>/**</em>
<a name="552" href="#552">552</a> <em>     * Get the qualified name of an attribute.</em>
<a name="553" href="#553">553</a> <em>     *</em>
<a name="554" href="#554">554</a> <em>     * @param attribute the target node</em>
<a name="555" href="#555">555</a> <em>     * </em>
<a name="556" href="#556">556</a> <em>     * @return a string representing the qualified (i.e. possibly</em>
<a name="557" href="#557">557</a> <em>     * prefixed) name if the argument is an attribute, or null otherwise</em>
<a name="558" href="#558">558</a> <em>     */</em>
<a name="559" href="#559">559</a>     <strong>public</strong> String getAttributeQName (Object attribute)
<a name="560" href="#560">560</a>     {
<a name="561" href="#561">561</a>         <strong>try</strong> {
<a name="562" href="#562">562</a>             Node node = (Node) attribute;
<a name="563" href="#563">563</a>             <strong>if</strong> (node.getNodeType() == Node.ATTRIBUTE_NODE) {
<a name="564" href="#564">564</a>                 <strong>return</strong> node.getNodeName();
<a name="565" href="#565">565</a>             }
<a name="566" href="#566">566</a>         }
<a name="567" href="#567">567</a>         <strong>catch</strong> (ClassCastException ex) {
<a name="568" href="#568">568</a>         }
<a name="569" href="#569">569</a>         <strong>return</strong> <strong>null</strong>;
<a name="570" href="#570">570</a>     }
<a name="571" href="#571">571</a> 
<a name="572" href="#572">572</a> 
<a name="573" href="#573">573</a>     <em>/**</em>
<a name="574" href="#574">574</a> <em>     * Test if a node is a top-level document.</em>
<a name="575" href="#575">575</a> <em>     *</em>
<a name="576" href="#576">576</a> <em>     * @param object the target node</em>
<a name="577" href="#577">577</a> <em>     * @return true if the node is the document root, false otherwise</em>
<a name="578" href="#578">578</a> <em>     */</em>
<a name="579" href="#579">579</a>     <strong>public</strong> <strong>boolean</strong> isDocument (Object object)
<a name="580" href="#580">580</a>     {
<a name="581" href="#581">581</a>         <strong>return</strong> (object instanceof Node) &amp;&amp;
<a name="582" href="#582">582</a>             (((Node)object).getNodeType() == Node.DOCUMENT_NODE);
<a name="583" href="#583">583</a>     }
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a> 
<a name="586" href="#586">586</a>     <em>/**</em>
<a name="587" href="#587">587</a> <em>     * Test if a node is a namespace.</em>
<a name="588" href="#588">588</a> <em>     *</em>
<a name="589" href="#589">589</a> <em>     * @param object the target node</em>
<a name="590" href="#590">590</a> <em>     * @return true if the node is a namespace, false otherwise</em>
<a name="591" href="#591">591</a> <em>     */</em>
<a name="592" href="#592">592</a>     <strong>public</strong> <strong>boolean</strong> isNamespace (Object object)
<a name="593" href="#593">593</a>     {
<a name="594" href="#594">594</a>         <strong>return</strong> (object instanceof NamespaceNode);
<a name="595" href="#595">595</a>     }
<a name="596" href="#596">596</a> 
<a name="597" href="#597">597</a> 
<a name="598" href="#598">598</a>     <em>/**</em>
<a name="599" href="#599">599</a> <em>     * Test if a node is an element.</em>
<a name="600" href="#600">600</a> <em>     *</em>
<a name="601" href="#601">601</a> <em>     * @param object the target node</em>
<a name="602" href="#602">602</a> <em>     * @return true if the node is an element, false otherwise</em>
<a name="603" href="#603">603</a> <em>     */</em>
<a name="604" href="#604">604</a>     <strong>public</strong> <strong>boolean</strong> isElement (Object object)
<a name="605" href="#605">605</a>     {
<a name="606" href="#606">606</a>         <strong>return</strong> (object instanceof Node) &amp;&amp;
<a name="607" href="#607">607</a>             (((Node)object).getNodeType() == Node.ELEMENT_NODE);
<a name="608" href="#608">608</a>     }
<a name="609" href="#609">609</a> 
<a name="610" href="#610">610</a> 
<a name="611" href="#611">611</a>     <em>/**</em>
<a name="612" href="#612">612</a> <em>     * Test if a node is an attribute. &lt;code>xmlns&lt;/code> and </em>
<a name="613" href="#613">613</a> <em>     * &lt;code>xmlns:pre&lt;/code> attributes do not count as attributes</em>
<a name="614" href="#614">614</a> <em>     * for the purposes of XPath. </em>
<a name="615" href="#615">615</a> <em>     *</em>
<a name="616" href="#616">616</a> <em>     * @param object the target node</em>
<a name="617" href="#617">617</a> <em>     * @return true if the node is an attribute, false otherwise</em>
<a name="618" href="#618">618</a> <em>     */</em>
<a name="619" href="#619">619</a>     <strong>public</strong> <strong>boolean</strong> isAttribute (Object object)
<a name="620" href="#620">620</a>     {
<a name="621" href="#621">621</a>         <strong>return</strong> (object instanceof Node) &amp;&amp;
<a name="622" href="#622">622</a>             (((Node)object).getNodeType() == Node.ATTRIBUTE_NODE)
<a name="623" href="#623">623</a>             &amp;&amp; ! <span class="string">"http://www.w3.org/2000/xmlns/"</span>.equals(((Node) object).getNamespaceURI());
<a name="624" href="#624">624</a>     }
<a name="625" href="#625">625</a> 
<a name="626" href="#626">626</a> 
<a name="627" href="#627">627</a>     <em>/**</em>
<a name="628" href="#628">628</a> <em>     * Test if a node is a comment.</em>
<a name="629" href="#629">629</a> <em>     *</em>
<a name="630" href="#630">630</a> <em>     * @param object the target node</em>
<a name="631" href="#631">631</a> <em>     * @return true if the node is a comment, false otherwise</em>
<a name="632" href="#632">632</a> <em>     */</em>
<a name="633" href="#633">633</a>     <strong>public</strong> <strong>boolean</strong> isComment (Object object)
<a name="634" href="#634">634</a>     {
<a name="635" href="#635">635</a>         <strong>return</strong> (object instanceof Node) &amp;&amp;
<a name="636" href="#636">636</a>             (((Node)object).getNodeType() == Node.COMMENT_NODE);
<a name="637" href="#637">637</a>     }
<a name="638" href="#638">638</a> 
<a name="639" href="#639">639</a> 
<a name="640" href="#640">640</a>     <em>/**</em>
<a name="641" href="#641">641</a> <em>     * Test if a node is plain text.</em>
<a name="642" href="#642">642</a> <em>     *</em>
<a name="643" href="#643">643</a> <em>     * @param object the target node</em>
<a name="644" href="#644">644</a> <em>     * @return true if the node is a text node, false otherwise</em>
<a name="645" href="#645">645</a> <em>     */</em>
<a name="646" href="#646">646</a>     <strong>public</strong> <strong>boolean</strong> isText (Object object)
<a name="647" href="#647">647</a>     {
<a name="648" href="#648">648</a>         <strong>if</strong> (object instanceof Node) {
<a name="649" href="#649">649</a>             <strong>switch</strong> (((Node)object).getNodeType()) {
<a name="650" href="#650">650</a>                 <strong>case</strong> Node.TEXT_NODE:
<a name="651" href="#651">651</a>                 <strong>case</strong> Node.CDATA_SECTION_NODE:
<a name="652" href="#652">652</a>                     <strong>return</strong> <strong>true</strong>;
<a name="653" href="#653">653</a>                 <strong>default</strong>:
<a name="654" href="#654">654</a>                     <strong>return</strong> false;
<a name="655" href="#655">655</a>             }
<a name="656" href="#656">656</a>         } <strong>else</strong> {
<a name="657" href="#657">657</a>             <strong>return</strong> false;
<a name="658" href="#658">658</a>         }
<a name="659" href="#659">659</a>     }
<a name="660" href="#660">660</a> 
<a name="661" href="#661">661</a> 
<a name="662" href="#662">662</a>     <em>/**</em>
<a name="663" href="#663">663</a> <em>     * Test if a node is a processing instruction.</em>
<a name="664" href="#664">664</a> <em>     *</em>
<a name="665" href="#665">665</a> <em>     * @param object the target node</em>
<a name="666" href="#666">666</a> <em>     * @return true if the node is a processing instruction, false otherwise</em>
<a name="667" href="#667">667</a> <em>     */</em>
<a name="668" href="#668">668</a>     <strong>public</strong> <strong>boolean</strong> isProcessingInstruction (Object object)
<a name="669" href="#669">669</a>     {
<a name="670" href="#670">670</a>         <strong>return</strong> (object instanceof Node) &amp;&amp;
<a name="671" href="#671">671</a>             (((Node)object).getNodeType() == Node.PROCESSING_INSTRUCTION_NODE);
<a name="672" href="#672">672</a>     }
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a> 
<a name="675" href="#675">675</a>     <em>/**</em>
<a name="676" href="#676">676</a> <em>     * Get the string value of an element node.</em>
<a name="677" href="#677">677</a> <em>     *</em>
<a name="678" href="#678">678</a> <em>     * @param object the target node</em>
<a name="679" href="#679">679</a> <em>     * @return the text inside the node and its descendants if the node</em>
<a name="680" href="#680">680</a> <em>     * is an element, null otherwise</em>
<a name="681" href="#681">681</a> <em>     */</em>
<a name="682" href="#682">682</a>     <strong>public</strong> String getElementStringValue (Object object)
<a name="683" href="#683">683</a>     {
<a name="684" href="#684">684</a>         <strong>if</strong> (isElement(object)) {
<a name="685" href="#685">685</a>             <strong>return</strong> getStringValue((Node)object, <strong>new</strong> StringBuffer()).toString();
<a name="686" href="#686">686</a>         }
<a name="687" href="#687">687</a>         <strong>else</strong> {
<a name="688" href="#688">688</a>             <strong>return</strong> <strong>null</strong>;
<a name="689" href="#689">689</a>         }
<a name="690" href="#690">690</a>     }
<a name="691" href="#691">691</a> 
<a name="692" href="#692">692</a> 
<a name="693" href="#693">693</a>     <em>/**</em>
<a name="694" href="#694">694</a> <em>     * Construct a node's string value recursively.</em>
<a name="695" href="#695">695</a> <em>     *</em>
<a name="696" href="#696">696</a> <em>     * @param node the current node</em>
<a name="697" href="#697">697</a> <em>     * @param buffer the buffer for building the text</em>
<a name="698" href="#698">698</a> <em>     * @return the buffer passed as a parameter (for convenience)</em>
<a name="699" href="#699">699</a> <em>     */</em>
<a name="700" href="#700">700</a>     <strong>private</strong> StringBuffer getStringValue (Node node, StringBuffer buffer)
<a name="701" href="#701">701</a>     {
<a name="702" href="#702">702</a>         <strong>if</strong> (isText(node)) {
<a name="703" href="#703">703</a>             buffer.append(node.getNodeValue());
<a name="704" href="#704">704</a>         } <strong>else</strong> {
<a name="705" href="#705">705</a>             NodeList children = node.getChildNodes();
<a name="706" href="#706">706</a>             <strong>int</strong> length = children.getLength();
<a name="707" href="#707">707</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; length; i++) {
<a name="708" href="#708">708</a>                 getStringValue(children.item(i), buffer);
<a name="709" href="#709">709</a>             }
<a name="710" href="#710">710</a>         }
<a name="711" href="#711">711</a>         <strong>return</strong> buffer;
<a name="712" href="#712">712</a>     }
<a name="713" href="#713">713</a> 
<a name="714" href="#714">714</a> 
<a name="715" href="#715">715</a>     <em>/**</em>
<a name="716" href="#716">716</a> <em>     * Get the string value of an attribute node.</em>
<a name="717" href="#717">717</a> <em>     *</em>
<a name="718" href="#718">718</a> <em>     * @param object the target node</em>
<a name="719" href="#719">719</a> <em>     * @return the text of the attribute value if the node is an</em>
<a name="720" href="#720">720</a> <em>     *     attribute, null otherwise</em>
<a name="721" href="#721">721</a> <em>     */</em>
<a name="722" href="#722">722</a>     <strong>public</strong> String getAttributeStringValue (Object object)
<a name="723" href="#723">723</a>     {
<a name="724" href="#724">724</a>         <strong>if</strong> (isAttribute(object)) <strong>return</strong> ((Node)object).getNodeValue();
<a name="725" href="#725">725</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="726" href="#726">726</a>     }
<a name="727" href="#727">727</a> 
<a name="728" href="#728">728</a> 
<a name="729" href="#729">729</a>     <em>/**</em>
<a name="730" href="#730">730</a> <em>     * Get the string value of text.</em>
<a name="731" href="#731">731</a> <em>     *</em>
<a name="732" href="#732">732</a> <em>     * @param object the target node</em>
<a name="733" href="#733">733</a> <em>     * @return the string of text if the node is text, null otherwise</em>
<a name="734" href="#734">734</a> <em>     */</em>
<a name="735" href="#735">735</a>     <strong>public</strong> String getTextStringValue (Object object)
<a name="736" href="#736">736</a>     {
<a name="737" href="#737">737</a>         <strong>if</strong> (isText(object)) <strong>return</strong> ((Node)object).getNodeValue();
<a name="738" href="#738">738</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="739" href="#739">739</a>     }
<a name="740" href="#740">740</a> 
<a name="741" href="#741">741</a> 
<a name="742" href="#742">742</a>     <em>/**</em>
<a name="743" href="#743">743</a> <em>     * Get the string value of a comment node.</em>
<a name="744" href="#744">744</a> <em>     *</em>
<a name="745" href="#745">745</a> <em>     * @param object the target node</em>
<a name="746" href="#746">746</a> <em>     * @return the text of the comment if the node is a comment, null otherwise</em>
<a name="747" href="#747">747</a> <em>     */</em>
<a name="748" href="#748">748</a>     <strong>public</strong> String getCommentStringValue (Object object)
<a name="749" href="#749">749</a>     {
<a name="750" href="#750">750</a>         <strong>if</strong> (isComment(object)) <strong>return</strong> ((Node)object).getNodeValue();
<a name="751" href="#751">751</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="752" href="#752">752</a>     }
<a name="753" href="#753">753</a> 
<a name="754" href="#754">754</a> 
<a name="755" href="#755">755</a>     <em>/**</em>
<a name="756" href="#756">756</a> <em>     * Get the string value of a namespace node.</em>
<a name="757" href="#757">757</a> <em>     *</em>
<a name="758" href="#758">758</a> <em>     * @param object the target node</em>
<a name="759" href="#759">759</a> <em>     * @return the namespace URI as a (possibly empty) string if the</em>
<a name="760" href="#760">760</a> <em>     *     node is a namespace node, null otherwise</em>
<a name="761" href="#761">761</a> <em>     */</em>
<a name="762" href="#762">762</a>     <strong>public</strong> String getNamespaceStringValue (Object object)
<a name="763" href="#763">763</a>     {
<a name="764" href="#764">764</a>         <strong>if</strong> (isNamespace(object)) <strong>return</strong> ((NamespaceNode)object).getNodeValue();
<a name="765" href="#765">765</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="766" href="#766">766</a>     }
<a name="767" href="#767">767</a> 
<a name="768" href="#768">768</a>     <em>/**</em>
<a name="769" href="#769">769</a> <em>     * Get the prefix value of a namespace node.</em>
<a name="770" href="#770">770</a> <em>     *</em>
<a name="771" href="#771">771</a> <em>     * @param object the target node</em>
<a name="772" href="#772">772</a> <em>     * @return the namespace prefix a (possibly empty) string if the</em>
<a name="773" href="#773">773</a> <em>     *     node is a namespace node, null otherwise</em>
<a name="774" href="#774">774</a> <em>     */</em>
<a name="775" href="#775">775</a>     <strong>public</strong> String getNamespacePrefix (Object object)
<a name="776" href="#776">776</a>     {
<a name="777" href="#777">777</a>         <strong>if</strong> (isNamespace(object)) <strong>return</strong> ((NamespaceNode)object).getLocalName();
<a name="778" href="#778">778</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="779" href="#779">779</a>     }
<a name="780" href="#780">780</a> 
<a name="781" href="#781">781</a>     <em>/**</em>
<a name="782" href="#782">782</a> <em>     * Translate a namespace prefix to a URI.</em>
<a name="783" href="#783">783</a> <em>     * </em>
<a name="784" href="#784">784</a> <em>     * @param prefix the namespace prefix</em>
<a name="785" href="#785">785</a> <em>     * @param element the namespace context</em>
<a name="786" href="#786">786</a> <em>     * @return the namespace URI bound to the prefix in the scope of &lt;code>element&lt;/code>;</em>
<a name="787" href="#787">787</a> <em>     *     null if the prefix is not bound</em>
<a name="788" href="#788">788</a> <em>     */</em>
<a name="789" href="#789">789</a>     <strong>public</strong> String translateNamespacePrefixToUri (String prefix, Object element)
<a name="790" href="#790">790</a>     {
<a name="791" href="#791">791</a>         Iterator it = getNamespaceAxisIterator(element);
<a name="792" href="#792">792</a>         <strong>while</strong> (it.hasNext()) {
<a name="793" href="#793">793</a>             <a href="../../../org/jaxen/dom/NamespaceNode.html">NamespaceNode</a> ns = (NamespaceNode)it.next();
<a name="794" href="#794">794</a>             <strong>if</strong> (prefix.equals(ns.getNodeName())) <strong>return</strong> ns.getNodeValue();
<a name="795" href="#795">795</a>         }
<a name="796" href="#796">796</a>         <strong>return</strong> <strong>null</strong>;
<a name="797" href="#797">797</a>     }
<a name="798" href="#798">798</a> 
<a name="799" href="#799">799</a>     <em>/**</em>
<a name="800" href="#800">800</a> <em>     * Use JAXP to load a namespace aware document from a given URI.</em>
<a name="801" href="#801">801</a> <em>     *</em>
<a name="802" href="#802">802</a> <em>     * @param uri the URI of the document to load</em>
<a name="803" href="#803">803</a> <em>     * @return the new W3C DOM Level 2 Document instance</em>
<a name="804" href="#804">804</a> <em>     * @throws FunctionCallException containing a nested exception</em>
<a name="805" href="#805">805</a> <em>     *      if a problem occurs trying to parse the given document</em>
<a name="806" href="#806">806</a> <em>     *</em>
<a name="807" href="#807">807</a> <em>     * @todo Possibly we could make the factory a thread local.</em>
<a name="808" href="#808">808</a> <em>     */</em>
<a name="809" href="#809">809</a>     <strong>public</strong> Object getDocument(String uri) throws FunctionCallException
<a name="810" href="#810">810</a>     {
<a name="811" href="#811">811</a>         <strong>try</strong>
<a name="812" href="#812">812</a>         {
<a name="813" href="#813">813</a>             <em class="comment">// We really do need to construct a new factory here each time.</em>
<a name="814" href="#814">814</a>             <em class="comment">// DocumentBuilderFactory is not guaranteed to be thread safe? </em>
<a name="815" href="#815">815</a>             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
<a name="816" href="#816">816</a>             factory.setNamespaceAware(<strong>true</strong>);
<a name="817" href="#817">817</a>             DocumentBuilder builder = factory.newDocumentBuilder();
<a name="818" href="#818">818</a>             <strong>return</strong> builder.parse( uri );
<a name="819" href="#819">819</a>         }
<a name="820" href="#820">820</a>         <strong>catch</strong> (ParserConfigurationException e) {
<a name="821" href="#821">821</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/FunctionCallException.html">FunctionCallException</a>(<span class="string">"JAXP setup error in document() function: "</span> + e.getMessage(), e);
<a name="822" href="#822">822</a>         }
<a name="823" href="#823">823</a>         <strong>catch</strong> (SAXException e) {
<a name="824" href="#824">824</a>            <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/FunctionCallException.html">FunctionCallException</a>(<span class="string">"XML error in document() function: "</span> + e.getMessage(), e);
<a name="825" href="#825">825</a>         }
<a name="826" href="#826">826</a>         <strong>catch</strong> (IOException e) {
<a name="827" href="#827">827</a>            <strong>throw</strong> <strong>new</strong> <a href="../../../org/jaxen/FunctionCallException.html">FunctionCallException</a>(<span class="string">"I/O error in document() function: "</span> + e.getMessage(), e);
<a name="828" href="#828">828</a>         }
<a name="829" href="#829">829</a>         
<a name="830" href="#830">830</a>     }
<a name="831" href="#831">831</a>     
<a name="832" href="#832">832</a>     <em>/**</em>
<a name="833" href="#833">833</a> <em>     * Get the target of a processing instruction node.</em>
<a name="834" href="#834">834</a> <em>     * </em>
<a name="835" href="#835">835</a> <em>     * @param obj the processing instruction</em>
<a name="836" href="#836">836</a> <em>     * @return the target of the processing instruction</em>
<a name="837" href="#837">837</a> <em>     * @throws ClassCastException if obj is not a processing instruction</em>
<a name="838" href="#838">838</a> <em>     * </em>
<a name="839" href="#839">839</a> <em>     */</em>
<a name="840" href="#840">840</a>     <strong>public</strong> String getProcessingInstructionTarget(Object obj)
<a name="841" href="#841">841</a>     {      
<a name="842" href="#842">842</a>         <strong>if</strong> (isProcessingInstruction(obj)) {
<a name="843" href="#843">843</a>             ProcessingInstruction pi = (ProcessingInstruction) obj;
<a name="844" href="#844">844</a>             <strong>return</strong> pi.getTarget();
<a name="845" href="#845">845</a>         }
<a name="846" href="#846">846</a>         <strong>throw</strong> <strong>new</strong> ClassCastException(obj + <span class="string">" is not a processing instruction"</span>);
<a name="847" href="#847">847</a>     }
<a name="848" href="#848">848</a> 
<a name="849" href="#849">849</a>     <em>/**</em>
<a name="850" href="#850">850</a> <em>     * Get the data of a processing instruction node.</em>
<a name="851" href="#851">851</a> <em>     * </em>
<a name="852" href="#852">852</a> <em>     * @param obj the processing instruction</em>
<a name="853" href="#853">853</a> <em>     * @return the target of the processing instruction</em>
<a name="854" href="#854">854</a> <em>     * @throws ClassCastException if obj is not a processing instruction</em>
<a name="855" href="#855">855</a> <em>     * </em>
<a name="856" href="#856">856</a> <em>     */</em>
<a name="857" href="#857">857</a>     <strong>public</strong> String getProcessingInstructionData(Object obj)
<a name="858" href="#858">858</a>     {
<a name="859" href="#859">859</a>         <strong>if</strong> (isProcessingInstruction(obj)) {
<a name="860" href="#860">860</a>             ProcessingInstruction pi = (ProcessingInstruction) obj;
<a name="861" href="#861">861</a>             <strong>return</strong> pi.getData();
<a name="862" href="#862">862</a>         }
<a name="863" href="#863">863</a>         <strong>throw</strong> <strong>new</strong> ClassCastException(obj + <span class="string">" is not a processing instruction"</span>);
<a name="864" href="#864">864</a>     }
<a name="865" href="#865">865</a> 
<a name="866" href="#866">866</a>     
<a name="867" href="#867">867</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="868" href="#868">868</a>     <em class="comment">// Inner class: iterate over DOM nodes.</em>
<a name="869" href="#869">869</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="870" href="#870">870</a> 
<a name="871" href="#871">871</a> 
<a name="872" href="#872">872</a>     <em class="comment">// FIXME: needs to recurse into</em>
<a name="873" href="#873">873</a>     <em class="comment">// DocumentFragment and EntityReference</em>
<a name="874" href="#874">874</a>     <em class="comment">// to use their children.</em>
<a name="875" href="#875">875</a> 
<a name="876" href="#876">876</a>     <em>/**</em>
<a name="877" href="#877">877</a> <em>     * A generic iterator over DOM nodes.</em>
<a name="878" href="#878">878</a> <em>     *</em>
<a name="879" href="#879">879</a> <em>     * &lt;p>Concrete subclasses must implement the {@link #getFirstNode}</em>
<a name="880" href="#880">880</a> <em>     * and {@link #getNextNode} methods for a specific iteration</em>
<a name="881" href="#881">881</a> <em>     * strategy.&lt;/p></em>
<a name="882" href="#882">882</a> <em>     */</em>
<a name="883" href="#883">883</a>     <strong>abstract</strong> <strong>class</strong> NodeIterator
<a name="884" href="#884">884</a>     implements Iterator
<a name="885" href="#885">885</a>     {
<a name="886" href="#886">886</a> 
<a name="887" href="#887">887</a> 
<a name="888" href="#888">888</a>         <em>/**</em>
<a name="889" href="#889">889</a> <em>         * Constructor.</em>
<a name="890" href="#890">890</a> <em>         *</em>
<a name="891" href="#891">891</a> <em>         * @param contextNode the starting node</em>
<a name="892" href="#892">892</a> <em>         */</em>
<a name="893" href="#893">893</a>         <strong>public</strong> NodeIterator (Node contextNode)
<a name="894" href="#894">894</a>         {
<a name="895" href="#895">895</a>             node = getFirstNode(contextNode);
<a name="896" href="#896">896</a>             <strong>while</strong> (!isXPathNode(node)) {
<a name="897" href="#897">897</a>                 node = getNextNode(node);
<a name="898" href="#898">898</a>             }
<a name="899" href="#899">899</a>         }
<a name="900" href="#900">900</a> 
<a name="901" href="#901">901</a>         <strong>public</strong> <strong>boolean</strong> hasNext ()
<a name="902" href="#902">902</a>         {
<a name="903" href="#903">903</a>             <strong>return</strong> (node != <strong>null</strong>);
<a name="904" href="#904">904</a>         }
<a name="905" href="#905">905</a> 
<a name="906" href="#906">906</a>         <strong>public</strong> Object next ()
<a name="907" href="#907">907</a>         {
<a name="908" href="#908">908</a>             <strong>if</strong> (node == <strong>null</strong>) <strong>throw</strong> <strong>new</strong> NoSuchElementException();
<a name="909" href="#909">909</a>             Node ret = node;
<a name="910" href="#910">910</a>             node = getNextNode(node);
<a name="911" href="#911">911</a>             <strong>while</strong> (!isXPathNode(node)) {
<a name="912" href="#912">912</a>                 node = getNextNode(node);
<a name="913" href="#913">913</a>             }
<a name="914" href="#914">914</a>             <strong>return</strong> ret;
<a name="915" href="#915">915</a>         }
<a name="916" href="#916">916</a> 
<a name="917" href="#917">917</a>         <strong>public</strong> <strong>void</strong> remove ()
<a name="918" href="#918">918</a>         {
<a name="919" href="#919">919</a>             <strong>throw</strong> <strong>new</strong> UnsupportedOperationException();
<a name="920" href="#920">920</a>         }
<a name="921" href="#921">921</a> 
<a name="922" href="#922">922</a> 
<a name="923" href="#923">923</a>         <em>/**</em>
<a name="924" href="#924">924</a> <em>         * Get the first node for iteration.</em>
<a name="925" href="#925">925</a> <em>         *</em>
<a name="926" href="#926">926</a> <em>         * &lt;p>This method must derive an initial node for iteration</em>
<a name="927" href="#927">927</a> <em>         * from a context node.&lt;/p></em>
<a name="928" href="#928">928</a> <em>         *</em>
<a name="929" href="#929">929</a> <em>         * @param contextNode the starting node</em>
<a name="930" href="#930">930</a> <em>         * @return the first node in the iteration</em>
<a name="931" href="#931">931</a> <em>         * @see #getNextNode</em>
<a name="932" href="#932">932</a> <em>         */</em>
<a name="933" href="#933">933</a>         <strong>protected</strong> <strong>abstract</strong> Node getFirstNode (Node contextNode);
<a name="934" href="#934">934</a> 
<a name="935" href="#935">935</a> 
<a name="936" href="#936">936</a>         <em>/**</em>
<a name="937" href="#937">937</a> <em>         * Get the next node for iteration.</em>
<a name="938" href="#938">938</a> <em>         *</em>
<a name="939" href="#939">939</a> <em>         * &lt;p>This method must locate a following node from the</em>
<a name="940" href="#940">940</a> <em>         * current context node.&lt;/p></em>
<a name="941" href="#941">941</a> <em>         *</em>
<a name="942" href="#942">942</a> <em>         * @param contextNode the current node in the iteration</em>
<a name="943" href="#943">943</a> <em>         * @return the following node in the iteration, or null</em>
<a name="944" href="#944">944</a> <em>         * if there is none</em>
<a name="945" href="#945">945</a> <em>         * @see #getFirstNode</em>
<a name="946" href="#946">946</a> <em>         */</em>
<a name="947" href="#947">947</a>         <strong>protected</strong> <strong>abstract</strong> Node getNextNode (Node contextNode);
<a name="948" href="#948">948</a> 
<a name="949" href="#949">949</a> 
<a name="950" href="#950">950</a>         <em>/**</em>
<a name="951" href="#951">951</a> <em>         * Test whether a DOM node is usable by XPath.</em>
<a name="952" href="#952">952</a> <em>         *</em>
<a name="953" href="#953">953</a> <em>         * @param node the DOM node to test</em>
<a name="954" href="#954">954</a> <em>         * @return true if the node is usable, false if it should be skipped</em>
<a name="955" href="#955">955</a> <em>         */</em>
<a name="956" href="#956">956</a>         <strong>private</strong> <strong>boolean</strong> isXPathNode (Node node)
<a name="957" href="#957">957</a>         {
<a name="958" href="#958">958</a>             <em class="comment">// null is usable, because it means end</em>
<a name="959" href="#959">959</a>             <strong>if</strong> (node == <strong>null</strong>) <strong>return</strong> <strong>true</strong>;
<a name="960" href="#960">960</a> 
<a name="961" href="#961">961</a>             <strong>switch</strong> (node.getNodeType()) {
<a name="962" href="#962">962</a>                 <strong>case</strong> Node.DOCUMENT_FRAGMENT_NODE:
<a name="963" href="#963">963</a>                 <strong>case</strong> Node.DOCUMENT_TYPE_NODE:
<a name="964" href="#964">964</a>                 <strong>case</strong> Node.ENTITY_NODE:
<a name="965" href="#965">965</a>                 <strong>case</strong> Node.ENTITY_REFERENCE_NODE:
<a name="966" href="#966">966</a>                 <strong>case</strong> Node.NOTATION_NODE:
<a name="967" href="#967">967</a>                     <strong>return</strong> false;
<a name="968" href="#968">968</a>                 <strong>default</strong>:
<a name="969" href="#969">969</a>                     <strong>return</strong> <strong>true</strong>;
<a name="970" href="#970">970</a>             }
<a name="971" href="#971">971</a>         }
<a name="972" href="#972">972</a> 
<a name="973" href="#973">973</a>         <strong>private</strong> Node node;
<a name="974" href="#974">974</a>     }
<a name="975" href="#975">975</a> 
<a name="976" href="#976">976</a> 
<a name="977" href="#977">977</a>     
<a name="978" href="#978">978</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="979" href="#979">979</a>     <em class="comment">// Inner class: iterate over a DOM named node map.</em>
<a name="980" href="#980">980</a>     <em class="comment">////////////////////////////////////////////////////////////////////</em>
<a name="981" href="#981">981</a> 
<a name="982" href="#982">982</a> 
<a name="983" href="#983">983</a>     <em>/**</em>
<a name="984" href="#984">984</a> <em>     * An iterator over an attribute list.</em>
<a name="985" href="#985">985</a> <em>     */</em>
<a name="986" href="#986">986</a>     <strong>private</strong> <strong>static</strong> <strong>class</strong> AttributeIterator implements Iterator
<a name="987" href="#987">987</a>     {
<a name="988" href="#988">988</a> 
<a name="989" href="#989">989</a>         <em>/**</em>
<a name="990" href="#990">990</a> <em>         * Constructor.</em>
<a name="991" href="#991">991</a> <em>         *</em>
<a name="992" href="#992">992</a> <em>         * @param parent the parent DOM element for the attributes.</em>
<a name="993" href="#993">993</a> <em>         */</em>
<a name="994" href="#994">994</a>         AttributeIterator (Node parent)
<a name="995" href="#995">995</a>         {
<a name="996" href="#996">996</a>             <strong>this</strong>.map = parent.getAttributes();
<a name="997" href="#997">997</a>             <strong>this</strong>.pos = 0;
<a name="998" href="#998">998</a>             <strong>for</strong> (<strong>int</strong> i = <strong>this</strong>.map.getLength()-1; i >= 0; i--) {
<a name="999" href="#999">999</a>                 Node node = map.item(i);
<a name="1000" href="#1000">1000</a>                 <strong>if</strong> (! <span class="string">"http://www.w3.org/2000/xmlns/"</span>.equals(node.getNamespaceURI())) {
<a name="1001" href="#1001">1001</a>                     <strong>this</strong>.lastAttribute  = i;
<a name="1002" href="#1002">1002</a>                     <strong>break</strong>;
<a name="1003" href="#1003">1003</a>                 }
<a name="1004" href="#1004">1004</a>             }
<a name="1005" href="#1005">1005</a>         }
<a name="1006" href="#1006">1006</a> 
<a name="1007" href="#1007">1007</a>         <strong>public</strong> <strong>boolean</strong> hasNext ()
<a name="1008" href="#1008">1008</a>         {
<a name="1009" href="#1009">1009</a>             <strong>return</strong> pos &lt;= lastAttribute;
<a name="1010" href="#1010">1010</a>         }
<a name="1011" href="#1011">1011</a> 
<a name="1012" href="#1012">1012</a>         <strong>public</strong> Object next ()
<a name="1013" href="#1013">1013</a>         {
<a name="1014" href="#1014">1014</a>             Node attr = map.item(pos++);
<a name="1015" href="#1015">1015</a>             <strong>if</strong> (attr == <strong>null</strong>) <strong>throw</strong> <strong>new</strong> NoSuchElementException();
<a name="1016" href="#1016">1016</a>             <strong>else</strong> <strong>if</strong> (<span class="string">"http://www.w3.org/2000/xmlns/"</span>.equals(attr.getNamespaceURI())) {
<a name="1017" href="#1017">1017</a>               <em class="comment">// XPath doesn't consider namespace declarations to be attributes </em>
<a name="1018" href="#1018">1018</a>               <em class="comment">// so skip it and go to the next one</em>
<a name="1019" href="#1019">1019</a>               <strong>return</strong> next();
<a name="1020" href="#1020">1020</a>             }
<a name="1021" href="#1021">1021</a>             <strong>else</strong> <strong>return</strong> attr;
<a name="1022" href="#1022">1022</a>         }
<a name="1023" href="#1023">1023</a> 
<a name="1024" href="#1024">1024</a>         <strong>public</strong> <strong>void</strong> remove ()
<a name="1025" href="#1025">1025</a>         {
<a name="1026" href="#1026">1026</a>             <strong>throw</strong> <strong>new</strong> UnsupportedOperationException();
<a name="1027" href="#1027">1027</a>         }
<a name="1028" href="#1028">1028</a> 
<a name="1029" href="#1029">1029</a> 
<a name="1030" href="#1030">1030</a>         <strong>private</strong> NamedNodeMap map;
<a name="1031" href="#1031">1031</a>         <strong>private</strong> <strong>int</strong> pos;
<a name="1032" href="#1032">1032</a>         <strong>private</strong> <strong>int</strong> lastAttribute = -1;
<a name="1033" href="#1033">1033</a> 
<a name="1034" href="#1034">1034</a>     }
<a name="1035" href="#1035">1035</a> 
<a name="1036" href="#1036">1036</a>     <em>/**</em>
<a name="1037" href="#1037">1037</a> <em>     *  Returns the element whose ID is given by elementId.</em>
<a name="1038" href="#1038">1038</a> <em>     *  If no such element exists, returns null.</em>
<a name="1039" href="#1039">1039</a> <em>     *  Attributes with the name "ID" are not of type ID unless so defined.</em>
<a name="1040" href="#1040">1040</a> <em>     *  Attribute types are only known if when the parser understands DTD's or</em>
<a name="1041" href="#1041">1041</a> <em>     *  schemas that declare attributes of type ID. When JAXP is used, you</em>
<a name="1042" href="#1042">1042</a> <em>     *  must call &lt;code>setValidating(true)&lt;/code> on the</em>
<a name="1043" href="#1043">1043</a> <em>     *  DocumentBuilderFactory.</em>
<a name="1044" href="#1044">1044</a> <em>     *</em>
<a name="1045" href="#1045">1045</a> <em>     *  @param object   a node from the document in which to look for the id</em>
<a name="1046" href="#1046">1046</a> <em>     *  @param elementId   id to look for</em>
<a name="1047" href="#1047">1047</a> <em>     *</em>
<a name="1048" href="#1048">1048</a> <em>     *  @return   element whose ID is given by elementId, or null if no such</em>
<a name="1049" href="#1049">1049</a> <em>     *            element exists in the document or if the implementation</em>
<a name="1050" href="#1050">1050</a> <em>     *            does not know about attribute types</em>
<a name="1051" href="#1051">1051</a> <em>     *  @see   javax.xml.parsers.DocumentBuilderFactory</em>
<a name="1052" href="#1052">1052</a> <em>     *  </em>
<a name="1053" href="#1053">1053</a> <em>     *  @throws ClassCastException if object is not an &lt;code>org.w3c.dom.Node&lt;/code> object</em>
<a name="1054" href="#1054">1054</a> <em>     *  </em>
<a name="1055" href="#1055">1055</a> <em>     */</em>
<a name="1056" href="#1056">1056</a>     <strong>public</strong> Object getElementById(Object object, String elementId)
<a name="1057" href="#1057">1057</a>     {
<a name="1058" href="#1058">1058</a>         Document doc = (Document)getDocumentNode(object);
<a name="1059" href="#1059">1059</a>         <strong>if</strong> (doc != <strong>null</strong>) <strong>return</strong> doc.getElementById(elementId);
<a name="1060" href="#1060">1060</a>         <strong>else</strong> <strong>return</strong> <strong>null</strong>;
<a name="1061" href="#1061">1061</a>     }
<a name="1062" href="#1062">1062</a> 
<a name="1063" href="#1063">1063</a> }
<a name="1064" href="#1064">1064</a> 
<a name="1065" href="#1065">1065</a> <em class="comment">// end of DocumentNavigator.java</em>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

